Link Label to Chat
Assign a specific label to a chat or contact.
Authentication Required
Login to swap the placeholders with your real Instance ID and Access Token.
Log InNo query parameters required
This endpoint doesn't expect data in the URL.
Best practices
Add a 'Bot Handled' label to chats your bot is managing.
Use labels to track the customer journey (e.g., Lead, Qualified, Closed).
Tagging Conversations: Mastering Semantic Orchestration
The Link Label to Chat endpoint is the primary mechanism for attaching strategic metadata to individual or group conversations. This is not merely a "visual tag"; it is a programmatic state-marker that allows your CRM, bots, and agents to interact with conversations based on their current business value or urgency.
🏗️ Core Concept: Metadata at the Conversation Edge
Think of labels as ** dynamic attributes ** that move a chat through your internal processing pipeline.
Key Architectural Principles:
- ** Additive Metadata **: A single chat can carry multiple labels simultaneously(e.g., "VIP" + "Pending Payment" + "Assigned to Team A").This allows for multi - dimensional filtering.
- ** Idempotency by Design **: Linking the same label to the same chat multiple times has zero side effects.This makes it safe to include tagging calls in high - frequency event loops without fear of duplication or errors.
- ** Silent Context **: Tagging is a purely internal operation.The customer never sees the labels, and no notification is sent to their device.It is a "Private Channel" for your organizational logic.
🚀 Strategic Operational Use Cases
1. Funnel State Management
Use this endpoint to move contacts through your sales funnel.As a user progresses from an "Inbound Lead" to a "Qualified Prospect," your system should link the relevant labels to reflect their increasing value.This allows your sales team to instantly prioritize their inbox based on funnel depth.
2. Auto - Tagging Intelligence
By integrating your messaging history with a sentiment analysis engine or a keyword detector, you can programmatically tag chats.
- ** Urgency Detection **: Automatically link an "Urgent" label if a user mentions "ASAP" or "Help."
- ** Intent Categorization **: Tag conversations as "Billing," "Support," or "Sales" based on the initial inbound message, ensuring they are routed to the correct department immediately.
3. CRM & System Synchronization
Mirror the state of your external CRM.If a lead's status is updated in Salesforce or HubSpot, use this endpoint to ensure that the agent looking at the WhatsApp app sees the exact same status in real-time. This "Side-by-Side Synchronization" prevents data silos and agent confusion.
🛠️ Integration Patterns: Orchestrating Clean Transitions
The "Step-Up" Transition
When moving a chat to a new state(e.g., from "Pending" to "Approved"), we recommend a "Link then Prune" pattern.First, link the new "Approved" label, then use the[Unlink endpoint](/v2/labels / { id } / chats / { chatId }) to remove the old "Pending" state.This ensures the chat is never without a category during the transition.
Event - Driven Tagging
Trigger tagging based on external business events.For example, when a payment is processed in your billing system, instantly link the "Paid" label to the customer's WhatsApp chat. This provides immediate visual confirmation to any agent who might be interacting with that customer.
🧪 Advanced Operational Safeguards
Scalability with Groups
This endpoint fully supports WhatsApp Group Chats(@g.us). This is powerful for B2B workflows where you might tag an entire project room as "Active" or "On Hold."
Handling the "ID Drift"
Always verify that the Label ID you are attempting to link is active in your global account directory. If a label has been deleted from the account, attempts to link it will result in a 404 error. Your system should listen for label.deleted events to prevent "Ghost Tagging" attempts.
⚡ Webhook Orchestration
Every successful link operation triggers a label.chat.added event. You can use this to:
- Trigger Notifications: Push a high-priority browser notification to an agent's dashboard.
- Launch Automations: Start a specific drip campaign or bot sequence when a "Warm Lead" label is applied.
🎯 Best Practices
- Action-Oriented Taxonomy: Use names like "To Follow Up" or "Needs Manager" instead of passive nouns. Labels should imply an action.
- Visual Consistency: Leverage the color indices to create an urgency hierarchy. Reserve Reds for high-priority tagging.
- Batching at Scale: When tagging a large segment of users (e.g., after a mass broadcast), implement a slight delay or use a background queue to ensure smooth propagation across Meta's servers.
- Prune Redundancy: Don't let chats accumulate 10+ labels. Maintain "Metadata Hygiene" by removing old stage labels as new ones are added.
Request Parameters
Configure the parameters required to interact with this endpoint. All query and body arguments are listed below with their details.
Request Body
Sent as a JSON objectstring | Your unique WhatsApp Instance ID Example: | ||
string | Your API Access Token Example: | ||
string | The unique ID of the label Example: | ||
string | Target phone number or group ID (@c.us, @g.us) Example: |
Request Samples
Use these ready-to-go code snippets to integrate our API into your project quickly and efficiently. Choose your preferred language and library.
Expected Responses
Explore all possible responses and outcomes from the server. We have documented each status code with data examples to make success and error handling easier.
Example
{
"success": true,
"message": "Operation completed successfully"
}Command Palette
Search for a command to run...